Skip to content

📖 [Docs]: Update README and examples#3

Merged
Marius Storhaug (MariusStorhaug) merged 1 commit into
mainfrom
docs
Feb 2, 2025
Merged

📖 [Docs]: Update README and examples#3
Marius Storhaug (MariusStorhaug) merged 1 commit into
mainfrom
docs

Conversation

@MariusStorhaug

@MariusStorhaug Marius Storhaug (MariusStorhaug) commented Feb 2, 2025

Copy link
Copy Markdown
Member

Description

This pull request includes significant updates to the README.md file and the examples/General.ps1 script to improve documentation and provide clearer examples of how to use the CasingStyle PowerShell module.

Documentation improvements:

  • README.md: Updated the module name and description, added detailed usage examples, clarified installation instructions, and provided links to further documentation for each function.

Example script enhancements:

  • examples/General.ps1: Replaced the generic example with specific usage examples of the Get-CasingStyle, ConvertTo-CasingStyle, and Split-CasingStyle functions, demonstrating various string transformations and detections.

Type of change

  • 📖 [Docs]
  • 🪲 [Fix]
  • 🩹 [Patch]
  • ⚠️ [Security fix]
  • 🚀 [Feature]
  • 🌟 [Breaking change]

Checklist

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas

@github-actions

github-actions Bot commented Feb 2, 2025

Copy link
Copy Markdown

Module Casing - v1.0.1 published to the PowerShell Gallery.

@github-actions

github-actions Bot commented Feb 2, 2025

Copy link
Copy Markdown

GitHub release for Casing v1.0.1 has been created.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant